<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>hsm-statechart: hsm/hsm_machine.c Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="hsm-statechart.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">hsm-statechart
   &#160;<span id="projectnumber">0.5</span>
   </div>
   <div id="projectbrief">An easy to use hierarchical state machine for C and C++</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('hsm__machine_8c.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">hsm_machine.c</div>  </div>
</div><!--header-->
<div class="contents">
<a href="hsm__machine_8c.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="hsm__machine_8h.html" title="Statemachine structures and functions.">hsm_machine.h</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;assert.h&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;stdlib.h&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;memory.h&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="hsm__context_8h.html" title="Support for optional per-state instance data.">hsm_context.h</a>&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="hsm__state_8h.html" title="Macros and typedefs used for declaring states.">hsm_state.h</a>&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="hsm__stack_8h.html" title="Internal stack manipulation routines used by hsm_machine for managing per state instance data...">hsm_stack.h</a>&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">// alloca is technically not an ANSI-C function, though it exists on most platforms</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#ifdef WIN32</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#ifndef alloca</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define alloca _alloca </span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="code" href="hsm__machine_8c.html#ae27734e5582668debb68db973903e2f9">   33</a></span>&#160;<span class="preprocessor">#define PSEUDO_STATE( Pseudo ) \</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">    static hsm_state _##Pseudo( hsm_status status ) { \</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">        return Pseudo(); \</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">    } \</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">    hsm_state Pseudo() { \</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">        static struct hsm_state_rec info= { #Pseudo, _##Pseudo };\</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">        return &amp;info;   \</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">    }</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<a class="code" href="hsm__machine_8c.html#ae27734e5582668debb68db973903e2f9" title="macro for making a pseudostate:">PSEUDO_STATE</a>( <a class="code" href="hsm__machine_8h.html#a385e51689fbbf6376b00a27029b7f79a" title="A machine in a final state has deliberately killed itself.">HsmStateFinal</a> );</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<a class="code" href="hsm__machine_8c.html#ae27734e5582668debb68db973903e2f9" title="macro for making a pseudostate:">PSEUDO_STATE</a>( <a class="code" href="hsm__machine_8h.html#a5574ce97f59edf4b77fafabc6ea36e54" title="Token state for when a machine has inadvertently killed itself.">HsmStateError</a> );</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<a class="code" href="hsm__machine_8c.html#ae27734e5582668debb68db973903e2f9" title="macro for making a pseudostate:">PSEUDO_STATE</a>( <a class="code" href="hsm__machine_8h.html#a3a16509f8bea2bca3f7b3f36525cc243" title="Token state that can be used by event handler functions to indicate the event was handled and no furt...">HsmStateHandled</a> );</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="keyword">static</span> <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> HsmDoNothing( <a class="code" href="hsm__status_8h.html#structhsm__status__rec" title="Structure used for consolidating callback parameters.">hsm_status</a> status ) { </div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keywordflow">return</span> NULL; </div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;}</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="hsm__machine_8h.html#a1ba67e8e0edddad002d4f4c44d0e73db">   50</a></span>&#160;<a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> <a class="code" href="hsm__machine_8c.html#a1ba67e8e0edddad002d4f4c44d0e73db" title="Token state for use with the HSM_STATE macros to represent the outer most state.">HsmTopState</a>() { </div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;}</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">#define HSM_STACK( hsm ) ((((hsm)-&gt;flags &amp; HSM_FLAGS_CTX)==HSM_FLAGS_CTX) ? &amp;((hsm_context_machine_t*)(hsm))-&gt;stack : 0)</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="keyword">static</span> hsm_bool HsmTransition( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> source, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> target, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> evt );</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> HsmRecursiveEnter( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> state, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> evt );</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> HsmEnter( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> state, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> evt );</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">/* </span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * @internal</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> * Transitions to the current states tree of initial states</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> * @return HSM_FALSE on error.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> * @note in statecharts, init happens after enter, and it can move ( often does move ) the current state to a new state</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> HsmInit( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> evt );</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">//static  &lt;- disabled for regions test. TODO: renable here and below.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="keywordtype">void</span> HsmExit( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> evt );</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="keyword">static</span> <a class="code" href="hsm__info_8h.html#structhsm__info__rec" title="Notification of important occurances in the state machine.">hsm_info_t</a> hsm_global_callbacks= {0};</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="code" href="hsm__machine_8c.html#aa76acf4404c88430c55d971d99c60e04">  106</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="hsm__info_8h.html#a333624d404e7c0dce2c73fd87b24fe36" title="Install a new set of callbacks for spying on internal statemachine processing.">HsmSetInfoCallbacks</a>( <a class="code" href="hsm__info_8h.html#structhsm__info__rec" title="Notification of important occurances in the state machine.">hsm_info_t</a>* info, <a class="code" href="hsm__info_8h.html#structhsm__info__rec" title="Notification of important occurances in the state machine.">hsm_info_t</a>* old_callbacks )</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;{</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    <span class="keywordflow">if</span> (old_callbacks) {</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        *old_callbacks= hsm_global_callbacks;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    }</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    hsm_global_callbacks= *info;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;}</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="hsm__machine_8h.html#a1d929cdbbb5066bd93e2f7f196394230">  115</a></span>&#160;<a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> <a class="code" href="hsm__machine_8c.html#a620a775df3ad215e489a9b487245749f" title="Initialize a statemachine to its default values.">HsmMachine</a>( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine_t</a>* hsm )</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;{</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    <a class="code" href="hsm__types_8h.html#ae90abec415767fe632682dddda6e1567" title="maps to an assert in debug builds compiles out in non-debug builds">HSM_ASSERT</a> (hsm);</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;    <span class="keywordflow">if</span> (hsm) {</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;        hsm-&gt;<a class="code" href="hsm__machine_8h.html#ae2338fb3d7fccbba312f3151d75cef88" title="Per state machine flags.">flags</a>=0;</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;        hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>= NULL;</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    }</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    <span class="keywordflow">return</span> hsm;</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;}</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="code" href="hsm__machine_8h.html#a7b65eb9c8ba636189595f96e90081bbb">  126</a></span>&#160;<a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> <a class="code" href="hsm__machine_8c.html#ac3c05a1d7215bdf5f9e4132a26dafca2" title="Initialize a statemachine with a context stack to its default values.">HsmMachineWithContext</a>( <a class="code" href="hsm__machine_8h.html#structhsm__context__machine__rec" title="Extends hsm_machine_rec with a context stack to provide per-state instance data.">hsm_context_machine_t</a>* hsm, <a class="code" href="hsm__context_8h.html#structhsm__context__rec" title="A per state instance context object.">hsm_context</a> ctx )</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;{</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <a class="code" href="hsm__types_8h.html#ae90abec415767fe632682dddda6e1567" title="maps to an assert in debug builds compiles out in non-debug builds">HSM_ASSERT</a>( hsm );</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    <span class="keywordflow">if</span> (hsm &amp;&amp; <a class="code" href="hsm__machine_8c.html#a620a775df3ad215e489a9b487245749f" title="Initialize a statemachine to its default values.">HsmMachine</a>( &amp;(hsm-&gt;<a class="code" href="hsm__machine_8h.html#a18c2fea85572ea48b12e33a8dcf51c9a" title="Core machine data.">core</a>) )) {</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;        <span class="comment">// flag that this has a context stack</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        hsm-&gt;<a class="code" href="hsm__machine_8h.html#a18c2fea85572ea48b12e33a8dcf51c9a" title="Core machine data.">core</a>.<a class="code" href="hsm__machine_8h.html#ae2338fb3d7fccbba312f3151d75cef88" title="Per state machine flags.">flags</a>|= HSM_FLAGS_CTX;</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;        <span class="comment">// initialize the stack &amp; set the outermost context</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;        <span class="comment">// we later use push to detect differences from this starting point</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;        <a class="code" href="hsm__context_8c.html#a6b9a76b7bb8ad4de9d5140789809f9c3" title="Resets the hsm_context_stack structure.">HsmContextStack</a>( &amp;(hsm-&gt;<a class="code" href="hsm__machine_8h.html#a241819e3262662e82a7d96795cbb44f2" title="Context stack for tracking optional per-state instance data.">stack</a>), ctx );</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;    }</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;    <span class="keywordflow">return</span> &amp;(hsm-&gt;<a class="code" href="hsm__machine_8h.html#a18c2fea85572ea48b12e33a8dcf51c9a" title="Core machine data.">core</a>);</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;}</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"><a class="code" href="hsm__machine_8h.html#a893207a7a8345aad604bd01a84ee9eb4">  140</a></span>&#160;hsm_bool <a class="code" href="hsm__machine_8c.html#a893207a7a8345aad604bd01a84ee9eb4" title="Determine if a machine has been started, and has not reached a terminal, nor an error state...">HsmIsRunning</a>( <span class="keyword">const</span> <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm )</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;{</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    <span class="keywordflow">return</span> hsm &amp;&amp; ((hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a> != <a class="code" href="hsm__machine_8h.html#a385e51689fbbf6376b00a27029b7f79a" title="A machine in a final state has deliberately killed itself.">HsmStateFinal</a>()) &amp;&amp;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;                   (hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a> != <a class="code" href="hsm__machine_8h.html#a5574ce97f59edf4b77fafabc6ea36e54" title="Token state for when a machine has inadvertently killed itself.">HsmStateError</a>()));</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;}</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"><a class="code" href="hsm__machine_8h.html#a3463ad5a97144c3c652b4f677644bcba">  147</a></span>&#160;hsm_bool <a class="code" href="hsm__machine_8c.html#a3463ad5a97144c3c652b4f677644bcba" title="Traverses the active state hierarchy to determine if hsm is possibly in the passed state...">HsmIsInState</a>( <span class="keyword">const</span> <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> state )</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;{</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    hsm_bool res=<a class="code" href="hsm__types_8h.html#a661d07d1e0324624dd94942951801df4" title="0">HSM_FALSE</a>;</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;    <span class="keywordflow">if</span> (hsm &amp;&amp; state) {</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;        <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> test;</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;        <span class="keywordflow">for</span> (test= hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>;  test; test=test-&gt;<a class="code" href="hsm__state_8h.html#aa4980a3eab7184813f0cd0a98a201fcb" title="parent of this state">parent</a>) {</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;            <span class="keywordflow">if</span> (res=(test==state)) {</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;                <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;            }</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;        }</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;    }        </div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;    <span class="keywordflow">return</span> res;</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;}</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="code" href="hsm__machine_8h.html#a3bb4f85b389637492451bf6e5429eaa2">  162</a></span>&#160;hsm_bool <a class="code" href="hsm__machine_8c.html#a7117ece3956d53414f80e1a340161f8a" title="Start a machine.">HsmStart</a>( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> first_state )</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;{</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    <a class="code" href="hsm__types_8h.html#ae90abec415767fe632682dddda6e1567" title="maps to an assert in debug builds compiles out in non-debug builds">HSM_ASSERT</a>( hsm );</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    <a class="code" href="hsm__types_8h.html#ae90abec415767fe632682dddda6e1567" title="maps to an assert in debug builds compiles out in non-debug builds">HSM_ASSERT</a>( first_state &amp;&amp; <span class="stringliteral">&quot;expected valid first state for init&quot;</span> );</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;    <a class="code" href="hsm__types_8h.html#ae90abec415767fe632682dddda6e1567" title="maps to an assert in debug builds compiles out in non-debug builds">HSM_ASSERT</a>( (!hsm || !hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>) &amp;&amp; <span class="stringliteral">&quot;already ran init&quot;</span> );</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    </div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;    <span class="keywordflow">if</span> (hsm &amp;&amp; !hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a> &amp;&amp; first_state ) </div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    {</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;        <span class="comment">// the specified starting state isn&#39;t necessarily the *top* state:</span></div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;        <span class="comment">// we need to walk up to the top state, then walk down to and including our first state</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;        HsmRecursiveEnter( hsm, first_state, NULL );</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;        <span class="comment">// statecharts run enter *then* init</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;        <span class="comment">// ( note: init can move us into a new state )</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;        HsmInit( hsm, NULL );</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;    }</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="hsm__machine_8c.html#a893207a7a8345aad604bd01a84ee9eb4" title="Determine if a machine has been started, and has not reached a terminal, nor an error state...">HsmIsRunning</a>( hsm );</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;}</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"><a class="code" href="hsm__machine_8h.html#a2e5511e0812b7613e3d1e496908bc8d0">  183</a></span>&#160;hsm_bool <a class="code" href="hsm__machine_8c.html#a2e5511e0812b7613e3d1e496908bc8d0" title="Send the passed event to the machine.">HsmSignalEvent</a>( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> evt )</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;{</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    hsm_bool okay= <a class="code" href="hsm__types_8h.html#a661d07d1e0324624dd94942951801df4" title="0">HSM_FALSE</a>;</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;    <span class="keywordflow">if</span> (hsm &amp;&amp; hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>) </div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;    {</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;        <span class="comment">// bubble the event up the hierarchy until we get a valid respose </span></div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;        <span class="comment">// ( or until we run off the top of the tree. )</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;        <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> next_state= NULL;</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;        <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> handler= hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>;</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;        <a class="code" href="hsm__stack_8h.html#structhsm__context__iterator__rec" title="Structure to traverse a context stack.">hsm_context_iterator_t</a> it;</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;        <a class="code" href="hsm__context_8c.html#a92505c79691b3926022a74c9657c12bd" title="Initialize the iterator to the most recent state&#39;s context.">HsmContextIterator</a>( &amp;it, HSM_STACK( hsm ) );</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;        <span class="keywordflow">do</span> {</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;            <span class="keywordflow">if</span> (handler-&gt;<a class="code" href="hsm__state_8h.html#a33029b0d2695fe40010884b199bd7546" title="the state&#39;s event handler callback">process</a>) {</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;                <a class="code" href="hsm__status_8h.html#structhsm__status__rec" title="Structure used for consolidating callback parameters.">hsm_status_t</a> status= { hsm, handler, it.<a class="code" href="hsm__stack_8h.html#a74b87d8a36ddc6006b1f4511c8b2b48f" title="pointer to the current unique context data">context</a>, evt };</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;                next_state= handler-&gt;<a class="code" href="hsm__state_8h.html#a33029b0d2695fe40010884b199bd7546" title="the state&#39;s event handler callback">process</a>( &amp;status ) ;</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;                <span class="keywordflow">if</span> (next_state) {</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;                    <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;                }</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;            }</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;            <a class="code" href="hsm__context_8c.html#a2d77747e2f011c189e20001f3bbd4a68" title="Advance the iterator to the parent state&#39;s context, return the parent context.">HsmParentContext</a>( &amp;it );</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;            handler= handler-&gt;<a class="code" href="hsm__state_8h.html#aa4980a3eab7184813f0cd0a98a201fcb" title="parent of this state">parent</a>;</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;        }</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;        <span class="keywordflow">while</span> (handler);           </div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;        <span class="comment">// handlers are supposed to return HsmStateHandled</span></div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;        <span class="keywordflow">if</span> (!next_state) {</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;            <span class="keywordflow">if</span> (hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a56fdc749c2115917e29d901e0a2847cd" title="Called whenever the machine doesnt handle an event.">on_unhandled_event</a>) {</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;                <a class="code" href="hsm__status_8h.html#structhsm__status__rec" title="Structure used for consolidating callback parameters.">hsm_status_t</a> status= { hsm, NULL, NULL, evt };</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;                hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a56fdc749c2115917e29d901e0a2847cd" title="Called whenever the machine doesnt handle an event.">on_unhandled_event</a>( &amp;status, hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a0f53d287ac7c064d1a49d4bd93ca1cb9" title="Custom user data.">user_data</a> );</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;            }</div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;        }</div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;        <span class="keywordflow">else</span> </div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;        <span class="keywordflow">if</span> (next_state== <a class="code" href="hsm__machine_8h.html#a3a16509f8bea2bca3f7b3f36525cc243" title="Token state that can be used by event handler functions to indicate the event was handled and no furt...">HsmStateHandled</a>()) {</div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;            okay= <a class="code" href="hsm__types_8h.html#ae231908aca4879403ae108cf0f5c7a9c" title="1">HSM_TRUE</a>;</div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;        }</div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;        <span class="keywordflow">else</span> </div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;        <span class="keywordflow">if</span> (next_state== <a class="code" href="hsm__machine_8h.html#a385e51689fbbf6376b00a27029b7f79a" title="A machine in a final state has deliberately killed itself.">HsmStateFinal</a>() || next_state==<a class="code" href="hsm__machine_8h.html#a5574ce97f59edf4b77fafabc6ea36e54" title="Token state for when a machine has inadvertently killed itself.">HsmStateError</a>()) {</div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;            <span class="comment">// we say this is okay, in the sense that something happened.</span></div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;            <span class="comment">// trigger a callback to inform the user?</span></div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;            <span class="keywordflow">if</span> (hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a> != next_state) {</div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;                hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a> = next_state;</div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;                okay= <a class="code" href="hsm__types_8h.html#ae231908aca4879403ae108cf0f5c7a9c" title="1">HSM_TRUE</a>;</div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;            }</div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;        }</div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;        <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;            <span class="comment">// transition, and if all is well, init</span></div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;             <span class="keywordflow">if</span> (!HsmTransition( hsm, handler, next_state, evt )) {</div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;                hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>= <a class="code" href="hsm__machine_8h.html#a5574ce97f59edf4b77fafabc6ea36e54" title="Token state for when a machine has inadvertently killed itself.">HsmStateError</a>();</div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;             }</div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;             <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;                 HsmInit( hsm, evt );</div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;             }</div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;        }</div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;    }    </div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;    <span class="keywordflow">return</span> okay;</div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;}</div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;</div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment">// warning: this indirectly alters the current state and context stack ( via HsmEnter )</span></div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> HsmInit( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> cause )</div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;{</div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;    <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> initial_state;</div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;    <span class="keywordflow">while</span> ( initial_state= hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>-&gt;<a class="code" href="hsm__state_8h.html#a74ac4b1f244bc97ba0c1daab6f76979b" title="default sub-state (if any) for this state">initial</a> ) </div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;    {</div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;        hsm_bool init_moves_to_child= initial_state-&gt;<a class="code" href="hsm__state_8h.html#aa4980a3eab7184813f0cd0a98a201fcb" title="parent of this state">parent</a> == hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>;</div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;        <a class="code" href="hsm__types_8h.html#ae90abec415767fe632682dddda6e1567" title="maps to an assert in debug builds compiles out in non-debug builds">HSM_ASSERT</a>( init_moves_to_child &amp;&amp; <span class="stringliteral">&quot;malformed statechart: init doesnt move to child state&quot;</span> );</div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;</div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;        <span class="keywordflow">if</span> (hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#ab5271d6cac67a06921a905953f2a47f6" title="Called after just before a state enter occurs as a result of an initial state designation.">on_init</a>) {</div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;            <a class="code" href="hsm__context_8h.html#structhsm__context__stack__rec" title="Per state machine instance manager of context data.">hsm_context_stack_t</a>* stack= HSM_STACK( hsm );</div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;            <a class="code" href="hsm__status_8h.html#structhsm__status__rec" title="Structure used for consolidating callback parameters.">hsm_status_t</a> status= { hsm, hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>, stack ? stack-&gt;<a class="code" href="hsm__context_8h.html#a74b87d8a36ddc6006b1f4511c8b2b48f" title="most recently added unique context pointer">context</a>: 0, cause };</div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;            hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#ab5271d6cac67a06921a905953f2a47f6" title="Called after just before a state enter occurs as a result of an initial state designation.">on_init</a>( &amp;status, hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a0f53d287ac7c064d1a49d4bd93ca1cb9" title="Custom user data.">user_data</a> );</div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;        }       </div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;        </div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;        <span class="keywordflow">if</span> (!init_moves_to_child) {</div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;            hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>= <a class="code" href="hsm__machine_8h.html#a5574ce97f59edf4b77fafabc6ea36e54" title="Token state for when a machine has inadvertently killed itself.">HsmStateError</a>();</div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;            <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;        }</div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;        <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;            <span class="comment">// continue the enter=&gt;init pattern </span></div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;            <span class="comment">// ( the spec says enter runs before init. it sounds insane, but works out well. )</span></div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;            HsmEnter( hsm, initial_state, cause );</div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;        }</div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;    }</div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;}</div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;</div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;<span class="comment">// warning: this directly alters the current state ( and also modifies the context stack. )</span></div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;<span class="comment">// the original code did not, but this change help simplify: init, exit, and transition.</span></div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> HsmEnter( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> state, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> cause )</div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;{</div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;    <span class="comment">//FIXME-stravis: handle invalid states better?</span></div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;    <span class="keyword">const</span> hsm_bool valid_state= (state &amp;&amp; state-&gt;<a class="code" href="hsm__state_8h.html#acb5ba97551079e0b072c62c21d784ac5" title="distance to the root state this-&gt;depth = this-&gt;parent-&gt;depth+1; root most state&#39;s depth == 0...">depth</a> &gt;=0);</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;    <a class="code" href="hsm__types_8h.html#ae90abec415767fe632682dddda6e1567" title="maps to an assert in debug builds compiles out in non-debug builds">HSM_ASSERT</a>( valid_state );</div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;    <span class="keywordflow">if</span> (valid_state) {</div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;        <span class="comment">// note: each state gets the context of its parent in entry</span></div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;        <span class="comment">// and can optionally generate a new context in turn</span></div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;        <a class="code" href="hsm__context_8h.html#structhsm__context__stack__rec" title="Per state machine instance manager of context data.">hsm_context_stack_t</a>* stack= HSM_STACK( hsm );</div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;        <a class="code" href="hsm__status_8h.html#structhsm__status__rec" title="Structure used for consolidating callback parameters.">hsm_status_t</a> status= { hsm, state, stack ? stack-&gt;<a class="code" href="hsm__context_8h.html#a74b87d8a36ddc6006b1f4511c8b2b48f" title="most recently added unique context pointer">context</a>: 0, cause };</div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;    </div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;        <span class="keywordflow">if</span> (state-&gt;<a class="code" href="hsm__state_8h.html#aa6a1c3b1e97b0015afee5573fb3ddc78" title="enter action handler">enter</a>) {</div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;            status.ctx= state-&gt;<a class="code" href="hsm__state_8h.html#aa6a1c3b1e97b0015afee5573fb3ddc78" title="enter action handler">enter</a>( &amp;status );</div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;        }</div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;        </div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;        <span class="comment">// push the new context, the stack handles dupes.</span></div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;        <a class="code" href="hsm__context_8c.html#ae38c05493a767abe0262890262492a99" title="Add a new context to the stack.">HsmContextPush</a>( stack, status.ctx ); </div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;        hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>= state;</div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;</div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;        <span class="comment">// informational callback, passing in new context</span></div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;        <span class="keywordflow">if</span> (hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#aa8b78c9f358bbea30bf816b6484edf2b" title="Called after every state&#39;s entry.">on_entered</a>) {</div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;            hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#aa8b78c9f358bbea30bf816b6484edf2b" title="Called after every state&#39;s entry.">on_entered</a>( &amp;status, hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a0f53d287ac7c064d1a49d4bd93ca1cb9" title="Custom user data.">user_data</a> );</div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;        }</div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;    }</div>
<div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;}</div>
<div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;</div>
<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;<span class="comment">// warning: this directly alters the current state ( and also modifies the context stack. )</span></div>
<div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;<span class="comment">// static </span></div>
<div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;<span class="keywordtype">void</span> HsmExit( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> cause )</div>
<div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;{</div>
<div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;    <span class="comment">// note: exit, just like process, gets the context enter created</span></div>
<div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;    <a class="code" href="hsm__context_8h.html#structhsm__context__rec" title="A per state instance context object.">hsm_context</a> popped;</div>
<div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;    <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> state= hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>;</div>
<div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;    <a class="code" href="hsm__context_8h.html#structhsm__context__stack__rec" title="Per state machine instance manager of context data.">hsm_context_stack_t</a> * stack= HSM_STACK( hsm );</div>
<div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;    <a class="code" href="hsm__status_8h.html#structhsm__status__rec" title="Structure used for consolidating callback parameters.">hsm_status_t</a> status= { hsm, state, stack ? stack-&gt;<a class="code" href="hsm__context_8h.html#a74b87d8a36ddc6006b1f4511c8b2b48f" title="most recently added unique context pointer">context</a>: 0, cause };</div>
<div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;</div>
<div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;    <span class="comment">// informational callback, passing the old context</span></div>
<div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;    <span class="keywordflow">if</span> (hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#ab40a00247a41083dd95d6205dbefe92b" title="Called just before every state&#39;s exit.">on_exiting</a>) {</div>
<div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;        hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#ab40a00247a41083dd95d6205dbefe92b" title="Called just before every state&#39;s exit.">on_exiting</a>( &amp;status, hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a0f53d287ac7c064d1a49d4bd93ca1cb9" title="Custom user data.">user_data</a> );</div>
<div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;    }</div>
<div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160;    </div>
<div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;    <span class="keywordflow">if</span> (state-&gt;<a class="code" href="hsm__state_8h.html#af28bc68a562cca87d34f862c6ba6d3d6" title="exit action handler">exit</a>) {</div>
<div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;        state-&gt;<a class="code" href="hsm__state_8h.html#af28bc68a562cca87d34f862c6ba6d3d6" title="exit action handler">exit</a>( &amp;status );</div>
<div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;    }</div>
<div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;</div>
<div class="line"><a name="l00317"></a><span class="lineno">  317</span>&#160;    <span class="comment">// exit pops the context that enter had created.</span></div>
<div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;    hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>= state-&gt;<a class="code" href="hsm__state_8h.html#aa4980a3eab7184813f0cd0a98a201fcb" title="parent of this state">parent</a>;</div>
<div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;    popped= <a class="code" href="hsm__context_8c.html#aee4fad29d8526e04c590847a69e9ed50" title="Remove the most recently added context.">HsmContextPop</a>( stack );</div>
<div class="line"><a name="l00320"></a><span class="lineno">  320</span>&#160;</div>
<div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;    <span class="comment">// finally: let the user know</span></div>
<div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;    <span class="keywordflow">if</span> (popped) {</div>
<div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;        <span class="keywordflow">if</span> (hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a065a693f2bc16e603c5c1c91092476c0" title="Called just after the context stack pops its data.">on_context_popped</a>) {</div>
<div class="line"><a name="l00324"></a><span class="lineno">  324</span>&#160;            hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a065a693f2bc16e603c5c1c91092476c0" title="Called just after the context stack pops its data.">on_context_popped</a>( &amp;status, hsm_global_callbacks.<a class="code" href="hsm__info_8h.html#a0f53d287ac7c064d1a49d4bd93ca1cb9" title="Custom user data.">user_data</a> );</div>
<div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160;        }</div>
<div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;        <span class="comment">// call the &quot;hsm_callback_context_popped&quot; of the item thats being popped</span></div>
<div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;        <span class="keywordflow">if</span> (popped-&gt;<a class="code" href="hsm__context_8h.html#ad0208ce8f889006d0c5f3d92c030dd2b" title="per context callback">popped</a>) {</div>
<div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;            popped-&gt;<a class="code" href="hsm__context_8h.html#ad0208ce8f889006d0c5f3d92c030dd2b" title="per context callback">popped</a>( popped );</div>
<div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;        }</div>
<div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160;    }</div>
<div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;}</div>
<div class="line"><a name="l00332"></a><span class="lineno">  332</span>&#160;</div>
<div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;<span class="comment">// warning: this indirectly alters the current state and context stack ( via HsmEnter  )</span></div>
<div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;<span class="keyword">static</span> <span class="keywordtype">void</span> HsmRecursiveEnter( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> state, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a> cause )</div>
<div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;{</div>
<div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;    <span class="keywordflow">if</span> (state) {</div>
<div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;        HsmRecursiveEnter( hsm, state-&gt;<a class="code" href="hsm__state_8h.html#aa4980a3eab7184813f0cd0a98a201fcb" title="parent of this state">parent</a>, cause);</div>
<div class="line"><a name="l00339"></a><span class="lineno">  339</span>&#160;        HsmEnter( hsm, state, cause );</div>
<div class="line"><a name="l00340"></a><span class="lineno">  340</span>&#160;    }</div>
<div class="line"><a name="l00341"></a><span class="lineno">  341</span>&#160;}</div>
<div class="line"><a name="l00342"></a><span class="lineno">  342</span>&#160;</div>
<div class="line"><a name="l00343"></a><span class="lineno">  343</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"><a class="code" href="hsm__machine_8c.html#a7eb625feb8c90638a86b0ce39ef77a88">  367</a></span>&#160;<span class="comment"></span><span class="preprocessor">#define ERROR_IF_FALSE( x, msg ) while(!(x)) { HSM_ASSERT(msg); return HSM_FALSE; }</span></div>
<div class="line"><a name="l00368"></a><span class="lineno">  368</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00369"></a><span class="lineno">  369</span>&#160;<span class="keyword">static</span> hsm_bool HsmTransition( <a class="code" href="hsm__machine_8h.html#structhsm__machine__rec" title="The statemachine object.">hsm_machine</a> hsm, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> source, <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> target, <a class="code" href="hsm__forwards_8h.html#ab8e8ab8d2eb97eb5cc6331d85262fb76" title="Pointer to an hsm_event_rec.">hsm_event</a>  cause )</div>
<div class="line"><a name="l00370"></a><span class="lineno">  370</span>&#160;{</div>
<div class="line"><a name="l00371"></a><span class="lineno">  371</span>&#160;    <span class="comment">// above ( I. ) specifically designates the lca of &#39;source&#39; and &#39;target&#39;.</span></div>
<div class="line"><a name="l00372"></a><span class="lineno">  372</span>&#160;    <span class="comment">// which can only, then, be the same node as &#39;source&#39; or, more likely, a node less deep than &#39;source&#39;.</span></div>
<div class="line"><a name="l00373"></a><span class="lineno">  373</span>&#160;    <span class="comment">// since &#39;source&#39; is the node that handled the event, and since events propogate from &#39;current&#39; up to the top of the tree </span></div>
<div class="line"><a name="l00374"></a><span class="lineno">  374</span>&#160;    <span class="comment">// that also means &#39;source&#39; is either the same node as, or higher than, &#39;current&#39;.</span></div>
<div class="line"><a name="l00375"></a><span class="lineno">  375</span>&#160;    <span class="comment">// ie. lca-&gt;depth &lt;= source-&gt;depth &lt;= current-&gt;depth</span></div>
<div class="line"><a name="l00376"></a><span class="lineno">  376</span>&#160;    <span class="comment">// therefore: as a first step, bring &#39;current&#39; to &#39;source&#39;, and work towards lca from there.</span></div>
<div class="line"><a name="l00377"></a><span class="lineno">  377</span>&#160;    <span class="keywordflow">while</span>( hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a> != source ) {</div>
<div class="line"><a name="l00378"></a><span class="lineno">  378</span>&#160;        HsmExit( hsm, cause );</div>
<div class="line"><a name="l00379"></a><span class="lineno">  379</span>&#160;        <a class="code" href="hsm__machine_8c.html#a7eb625feb8c90638a86b0ce39ef77a88" title="According to the http://www.w3.org/TR/scxml/#SelectingTransitions: I.">ERROR_IF_FALSE</a>( hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>, <span class="stringliteral">&quot;jumped past top&quot;</span> );</div>
<div class="line"><a name="l00380"></a><span class="lineno">  380</span>&#160;    }                </div>
<div class="line"><a name="l00381"></a><span class="lineno">  381</span>&#160;</div>
<div class="line"><a name="l00382"></a><span class="lineno">  382</span>&#160;    <span class="comment">// quick check for self transition: the source targeted itself ( III. above )</span></div>
<div class="line"><a name="l00383"></a><span class="lineno">  383</span>&#160;    <span class="keywordflow">if</span> ( hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a> == target ) {</div>
<div class="line"><a name="l00384"></a><span class="lineno">  384</span>&#160;        HsmExit( hsm, cause );</div>
<div class="line"><a name="l00385"></a><span class="lineno">  385</span>&#160;        <span class="comment">// ( &lt;--- note: in uml transitions actions would take place here )</span></div>
<div class="line"><a name="l00386"></a><span class="lineno">  386</span>&#160;        <span class="comment">// ( in hsm_statechart, they&#39;ve already happened by now )</span></div>
<div class="line"><a name="l00387"></a><span class="lineno">  387</span>&#160;        HsmEnter( hsm, target, cause );</div>
<div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;    }</div>
<div class="line"><a name="l00389"></a><span class="lineno">  389</span>&#160;    <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00390"></a><span class="lineno">  390</span>&#160;        <span class="comment">// the easiest entry path record is an object on the stack... </span></div>
<div class="line"><a name="l00391"></a><span class="lineno">  391</span>&#160;        <span class="comment">// doesnt worry too much about stack overflow, </span></div>
<div class="line"><a name="l00392"></a><span class="lineno">  392</span>&#160;        <span class="comment">// instead it lets the user control it via HSM_MAX_DEPTH...</span></div>
<div class="line"><a name="l00393"></a><span class="lineno">  393</span>&#160;        <span class="keywordtype">int</span> pt=0;</div>
<div class="line"><a name="l00394"></a><span class="lineno">  394</span>&#160;        <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> track= target;</div>
<div class="line"><a name="l00395"></a><span class="lineno">  395</span>&#160;        <span class="comment">// change to help simplify lua rocks</span></div>
<div class="line"><a name="l00396"></a><span class="lineno">  396</span>&#160;        <span class="comment">//hsm_state* path_to_target=(hsm_state*) alloca( target-&gt;depth * sizeof(hsm_state) );</span></div>
<div class="line"><a name="l00397"></a><span class="lineno">  397</span>&#160;        <a class="code" href="hsm__state_8h.html#structhsm__state__rec" title="a state descriptor http://dev.ionous.net/2012/06/state-descriptors.html">hsm_state</a> path_to_target[ <a class="code" href="hsm__types_8h.html#ab637799a2cec6917daef0f1600729aee" title="16">HSM_MAX_DEPTH</a> ];</div>
<div class="line"><a name="l00398"></a><span class="lineno">  398</span>&#160;        hsm_bool external_transition= 0;</div>
<div class="line"><a name="l00399"></a><span class="lineno">  399</span>&#160;        <span class="comment">//ERROR_IF_FALSE( path_to_target, &quot;out of space&quot; );</span></div>
<div class="line"><a name="l00400"></a><span class="lineno">  400</span>&#160;        <a class="code" href="hsm__machine_8c.html#a7eb625feb8c90638a86b0ce39ef77a88" title="According to the http://www.w3.org/TR/scxml/#SelectingTransitions: I.">ERROR_IF_FALSE</a>( target-&gt;<a class="code" href="hsm__state_8h.html#acb5ba97551079e0b072c62c21d784ac5" title="distance to the root state this-&gt;depth = this-&gt;parent-&gt;depth+1; root most state&#39;s depth == 0...">depth</a> &lt; <a class="code" href="hsm__types_8h.html#ab637799a2cec6917daef0f1600729aee" title="16">HSM_MAX_DEPTH</a>, <span class="stringliteral">&quot;transition max depth exceeded&quot;</span> );</div>
<div class="line"><a name="l00401"></a><span class="lineno">  401</span>&#160; </div>
<div class="line"><a name="l00402"></a><span class="lineno">  402</span>&#160;        <span class="comment">// source deep than target?</span></div>
<div class="line"><a name="l00403"></a><span class="lineno">  403</span>&#160;        <span class="keywordflow">if</span> (hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>-&gt;<a class="code" href="hsm__state_8h.html#acb5ba97551079e0b072c62c21d784ac5" title="distance to the root state this-&gt;depth = this-&gt;parent-&gt;depth+1; root most state&#39;s depth == 0...">depth</a> &gt; track-&gt;<a class="code" href="hsm__state_8h.html#acb5ba97551079e0b072c62c21d784ac5" title="distance to the root state this-&gt;depth = this-&gt;parent-&gt;depth+1; root most state&#39;s depth == 0...">depth</a>) {</div>
<div class="line"><a name="l00404"></a><span class="lineno">  404</span>&#160;            <span class="comment">// *exit* up to the same level</span></div>
<div class="line"><a name="l00405"></a><span class="lineno">  405</span>&#160;            <span class="keywordflow">while</span>( hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>-&gt;<a class="code" href="hsm__state_8h.html#acb5ba97551079e0b072c62c21d784ac5" title="distance to the root state this-&gt;depth = this-&gt;parent-&gt;depth+1; root most state&#39;s depth == 0...">depth</a> &gt; track-&gt;<a class="code" href="hsm__state_8h.html#acb5ba97551079e0b072c62c21d784ac5" title="distance to the root state this-&gt;depth = this-&gt;parent-&gt;depth+1; root most state&#39;s depth == 0...">depth</a>) {</div>
<div class="line"><a name="l00406"></a><span class="lineno">  406</span>&#160;                HsmExit( hsm, cause ); <span class="comment">// we exit, then move, b/c, if we don&#39;t leave the node we don&#39;t want an exit </span></div>
<div class="line"><a name="l00407"></a><span class="lineno">  407</span>&#160;                <a class="code" href="hsm__machine_8c.html#a7eb625feb8c90638a86b0ce39ef77a88" title="According to the http://www.w3.org/TR/scxml/#SelectingTransitions: I.">ERROR_IF_FALSE</a>( hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>, <span class="stringliteral">&quot;jumped past top&quot;</span> );  </div>
<div class="line"><a name="l00408"></a><span class="lineno">  408</span>&#160;            }</div>
<div class="line"><a name="l00409"></a><span class="lineno">  409</span>&#160;        }</div>
<div class="line"><a name="l00410"></a><span class="lineno">  410</span>&#160;        <span class="comment">// target deeper than source?</span></div>
<div class="line"><a name="l00411"></a><span class="lineno">  411</span>&#160;        <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00412"></a><span class="lineno">  412</span>&#160;            <span class="comment">// *record* its path up to the same level</span></div>
<div class="line"><a name="l00413"></a><span class="lineno">  413</span>&#160;            <span class="keywordflow">while</span> (track-&gt;<a class="code" href="hsm__state_8h.html#acb5ba97551079e0b072c62c21d784ac5" title="distance to the root state this-&gt;depth = this-&gt;parent-&gt;depth+1; root most state&#39;s depth == 0...">depth</a> &gt; hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>-&gt;<a class="code" href="hsm__state_8h.html#acb5ba97551079e0b072c62c21d784ac5" title="distance to the root state this-&gt;depth = this-&gt;parent-&gt;depth+1; root most state&#39;s depth == 0...">depth</a> ) {</div>
<div class="line"><a name="l00414"></a><span class="lineno">  414</span>&#160;                path_to_target[pt++]= track;</div>
<div class="line"><a name="l00415"></a><span class="lineno">  415</span>&#160;                track= track-&gt;<a class="code" href="hsm__state_8h.html#aa4980a3eab7184813f0cd0a98a201fcb" title="parent of this state">parent</a>;</div>
<div class="line"><a name="l00416"></a><span class="lineno">  416</span>&#160;                <a class="code" href="hsm__machine_8c.html#a7eb625feb8c90638a86b0ce39ef77a88" title="According to the http://www.w3.org/TR/scxml/#SelectingTransitions: I.">ERROR_IF_FALSE</a>( track, <span class="stringliteral">&quot;jumped past top&quot;</span> );</div>
<div class="line"><a name="l00417"></a><span class="lineno">  417</span>&#160;            }</div>
<div class="line"><a name="l00418"></a><span class="lineno">  418</span>&#160;</div>
<div class="line"><a name="l00419"></a><span class="lineno">  419</span>&#160;        <span class="comment">// trigger an external transition? (re: II. above)</span></div>
<div class="line"><a name="l00420"></a><span class="lineno">  420</span>&#160;        <span class="comment">// by design, in hsm-statechart all transitions are internal.</span></div>
<div class="line"><a name="l00421"></a><span class="lineno">  421</span>&#160;<span class="preprocessor">        #ifdef HSM_USE_EXTERNAL_TRANSITIONS</span></div>
<div class="line"><a name="l00422"></a><span class="lineno">  422</span>&#160;<span class="preprocessor"></span>            <span class="comment">// since track has now risen along the path of target-to-root</span></div>
<div class="line"><a name="l00423"></a><span class="lineno">  423</span>&#160;            <span class="comment">// and has reached the the level of source....</span></div>
<div class="line"><a name="l00424"></a><span class="lineno">  424</span>&#160;            <span class="comment">// if they are the same node, then source was an ancestor of target.</span></div>
<div class="line"><a name="l00425"></a><span class="lineno">  425</span>&#160;            <span class="keywordflow">if</span> (hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a> == track) {</div>
<div class="line"><a name="l00426"></a><span class="lineno">  426</span>&#160;                HsmExit( hsm, cause );       <span class="comment">// this bumps the current state up</span></div>
<div class="line"><a name="l00427"></a><span class="lineno">  427</span>&#160;                path_to_target[pt++]= track; <span class="comment">// record that we need to renter it</span></div>
<div class="line"><a name="l00428"></a><span class="lineno">  428</span>&#160;                track= hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>;         <span class="comment">// and bump track up to the same level</span></div>
<div class="line"><a name="l00429"></a><span class="lineno">  429</span>&#160;            }</div>
<div class="line"><a name="l00430"></a><span class="lineno">  430</span>&#160;<span class="preprocessor">        #endif            </span></div>
<div class="line"><a name="l00431"></a><span class="lineno">  431</span>&#160;<span class="preprocessor"></span>        }</div>
<div class="line"><a name="l00432"></a><span class="lineno">  432</span>&#160;            </div>
<div class="line"><a name="l00433"></a><span class="lineno">  433</span>&#160;        <span class="comment">// keep going up together till current and track have found each other</span></div>
<div class="line"><a name="l00434"></a><span class="lineno">  434</span>&#160;        <span class="comment">// ( keep exiting &#39;current&#39; as it goes up; keep recording &#39;track&#39; as *it* goes up )</span></div>
<div class="line"><a name="l00435"></a><span class="lineno">  435</span>&#160;        <span class="keywordflow">while</span> (hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>!= track) {</div>
<div class="line"><a name="l00436"></a><span class="lineno">  436</span>&#160;            HsmExit( hsm, cause ); </div>
<div class="line"><a name="l00437"></a><span class="lineno">  437</span>&#160;            path_to_target[pt++]= track;</div>
<div class="line"><a name="l00438"></a><span class="lineno">  438</span>&#160;            track= track-&gt;<a class="code" href="hsm__state_8h.html#aa4980a3eab7184813f0cd0a98a201fcb" title="parent of this state">parent</a>;</div>
<div class="line"><a name="l00439"></a><span class="lineno">  439</span>&#160;            <a class="code" href="hsm__machine_8c.html#a7eb625feb8c90638a86b0ce39ef77a88" title="According to the http://www.w3.org/TR/scxml/#SelectingTransitions: I.">ERROR_IF_FALSE</a>( hsm-&gt;<a class="code" href="hsm__machine_8h.html#a043934f01bf682050e4bf098f42a8d66" title="Inner-most state currently active.">current</a>&amp;&amp;track, <span class="stringliteral">&quot;jumped past top&quot;</span> );</div>
<div class="line"><a name="l00440"></a><span class="lineno">  440</span>&#160;        }            </div>
<div class="line"><a name="l00441"></a><span class="lineno">  441</span>&#160;</div>
<div class="line"><a name="l00442"></a><span class="lineno">  442</span>&#160;        <span class="comment">// ( &lt;--- note: in uml transitions actions would take place here )</span></div>
<div class="line"><a name="l00443"></a><span class="lineno">  443</span>&#160;        <span class="comment">// ( in hsm_statechart, they&#39;ve already happened by now )</span></div>
<div class="line"><a name="l00444"></a><span class="lineno">  444</span>&#160;</div>
<div class="line"><a name="l00445"></a><span class="lineno">  445</span>&#160;        <span class="comment">// now have current use path the we just recorded:</span></div>
<div class="line"><a name="l00446"></a><span class="lineno">  446</span>&#160;        <span class="comment">// it&#39;s turtles all the way down.</span></div>
<div class="line"><a name="l00447"></a><span class="lineno">  447</span>&#160;        <span class="keywordflow">while</span> (pt&gt;0) {</div>
<div class="line"><a name="l00448"></a><span class="lineno">  448</span>&#160;            track= path_to_target[--pt];</div>
<div class="line"><a name="l00449"></a><span class="lineno">  449</span>&#160;            HsmEnter( hsm, track, cause );</div>
<div class="line"><a name="l00450"></a><span class="lineno">  450</span>&#160;        }</div>
<div class="line"><a name="l00451"></a><span class="lineno">  451</span>&#160;    }</div>
<div class="line"><a name="l00452"></a><span class="lineno">  452</span>&#160;    <span class="comment">// note: on error we will have already returned HSM_FALSE</span></div>
<div class="line"><a name="l00453"></a><span class="lineno">  453</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="hsm__types_8h.html#ae231908aca4879403ae108cf0f5c7a9c" title="1">HSM_TRUE</a>;</div>
<div class="line"><a name="l00454"></a><span class="lineno">  454</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_6c36b64852547327283732128225c9d7.html">hsm</a></li><li class="navelem"><a class="el" href="hsm__machine_8c.html">hsm_machine.c</a></li>
    <li class="footer">Generated on Sat Jul 7 2012 22:48:11 for hsm-statechart by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
  </ul>
</div>
</body>
</html>
